/*
 * Copyright 2020 Haulmont.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package io.jmix.core.security;

import org.springframework.security.core.userdetails.UserDetails;
import org.springframework.security.core.userdetails.UserDetailsService;

import java.util.List;

/**
 * An extended {@link UserDetailsService} defining methods specific to Jmix.
 */
public interface UserRepository extends UserDetailsService {

    /**
     * Returns the built-in 'system' user.
     */
    UserDetails getSystemUser();

    /**
     * Returns the built-in 'anonymous' user.
     */
    UserDetails getAnonymousUser();

    /**
     * Returns the list of users whose username contains the given substring.
     */
    List<? extends UserDetails> getByUsernameLike(String substring);
}
